Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tools: remove excessive comments from .eslintrc #5151

Closed
wants to merge 2 commits into from

Conversation

Trott
Copy link
Member

@Trott Trott commented Feb 9, 2016

This PR is on top of #5135 and should not be landed until that PR lands.

The comments make the config hard to scan. They do not provide any
information that isn't in the documentation links referred to in
comments (that are not being removed here).

Additionally, all rule config sections are alphabetically ordered for
easier scanning etc.

/cc @silverwind

@Trott Trott added tools Issues and PRs related to the tools directory. lts-watch-v4.x labels Feb 9, 2016
@Trott
Copy link
Member Author

Trott commented Feb 9, 2016

Once #5135 lands, the diff should look like what you see at Trott@cc99a75

@@ -17,98 +17,60 @@ ecmaFeatures:
rules:
# Possible Errors
# list: https://github.com/eslint/eslint/tree/master/docs/rules#possible-errors
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe also remove list: from each section?

@silverwind
Copy link
Contributor

LGTM with suggestion.

@silverwind
Copy link
Contributor

Oh by the way, the commit title remove excessive is weird. Either remove excess or remove excessive comments would be better :)

@Trott Trott changed the title tools: remove excessive from .eslintrc tools: remove excessive comments from .eslintrc Feb 9, 2016
@Trott
Copy link
Member Author

Trott commented Feb 9, 2016

Commit message fixed, list: removed from comments too, thanks!

@Trott
Copy link
Member Author

Trott commented Feb 9, 2016

@Trott
Copy link
Member Author

Trott commented Feb 9, 2016

CI looks good, except for a Windows buildbot issue on one host. Shouldn't really affect anything because this is a linting tool change and nothing else, but I like my CIs green (or at least yellow), so let's try again:

https://ci.nodejs.org/job/node-test-pull-request/1603/

@jasnell
Copy link
Member

jasnell commented Feb 10, 2016

#5135 landed. Is this one ready to go? Looks like it might need a quick rebase.

The comments make the config hard to scan. They do not provide any
information that isn't in the documentation links referred to in
comments (that are not being removed here).

Additionally, all rule config sections are alphabetically ordered for
easier scanning etc.
@Trott
Copy link
Member Author

Trott commented Feb 10, 2016

@silverwind
Copy link
Contributor

LGTM

@Trott
Copy link
Member Author

Trott commented Feb 10, 2016

Unrelated known-ish flaky being addressed in another issue (and hopefully soon a PR), but otherwise, everything is OK.

Trott added a commit to Trott/io.js that referenced this pull request Feb 10, 2016
The comments make the config hard to scan. They do not provide any
information that isn't in the documentation links referred to in
comments (that are not being removed here).

Additionally, all rule config sections are alphabetically ordered for
easier scanning etc.

PR-URL: nodejs#5151
Reviewed-By: Roman Reiss <[email protected]>
@Trott
Copy link
Member Author

Trott commented Feb 10, 2016

Landed in 783a563

@Trott Trott closed this Feb 10, 2016
rvagg pushed a commit that referenced this pull request Feb 15, 2016
The comments make the config hard to scan. They do not provide any
information that isn't in the documentation links referred to in
comments (that are not being removed here).

Additionally, all rule config sections are alphabetically ordered for
easier scanning etc.

PR-URL: #5151
Reviewed-By: Roman Reiss <[email protected]>
MylesBorins pushed a commit that referenced this pull request Feb 18, 2016
The comments make the config hard to scan. They do not provide any
information that isn't in the documentation links referred to in
comments (that are not being removed here).

Additionally, all rule config sections are alphabetically ordered for
easier scanning etc.

PR-URL: #5151
Reviewed-By: Roman Reiss <[email protected]>
MylesBorins pushed a commit that referenced this pull request Feb 18, 2016
The comments make the config hard to scan. They do not provide any
information that isn't in the documentation links referred to in
comments (that are not being removed here).

Additionally, all rule config sections are alphabetically ordered for
easier scanning etc.

PR-URL: #5151
Reviewed-By: Roman Reiss <[email protected]>
@MylesBorins MylesBorins mentioned this pull request Feb 18, 2016
stefanmb pushed a commit to stefanmb/node that referenced this pull request Feb 23, 2016
The comments make the config hard to scan. They do not provide any
information that isn't in the documentation links referred to in
comments (that are not being removed here).

Additionally, all rule config sections are alphabetically ordered for
easier scanning etc.

PR-URL: nodejs#5151
Reviewed-By: Roman Reiss <[email protected]>
MylesBorins pushed a commit that referenced this pull request Mar 2, 2016
The comments make the config hard to scan. They do not provide any
information that isn't in the documentation links referred to in
comments (that are not being removed here).

Additionally, all rule config sections are alphabetically ordered for
easier scanning etc.

PR-URL: #5151
Reviewed-By: Roman Reiss <[email protected]>
@Trott Trott deleted the comments branch January 13, 2022 22:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tools Issues and PRs related to the tools directory.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants